DETAILS









SETTINGS / CODES
OK OK OK OK OK OK OK OK OK OK OK Settings / Codes

Local
All
Comps
Prefix

Postfix



SETTINGS / CID
OK OK OK OK OK OK OK OK OK OK OK Settings / CID

Nmbr Cuts/Define Date Time Name Ring Message Secret number Out of range Secret if less than Use CID Name Use CID Date & Time



SETTINGS / DEVICE
OK OK OK OK OK OK OK OK OK OK OK Settings / Device

Device Speed Unit Mode Flow control Open Device on Startup Reset after Open /Call Seek for OK respond Use OwnDevUnit Modem reset (init.) Pickup Hangup

Answer Dial SPKR VOLUME /OFF SPKR VOLUME /ON RESPONDS /OK RESPONDS /Busy RESPONDS /Error RESPONDS /In V.Mode



SETTINGS / MISC
OK OK OK OK OK OK OK OK OK OK OK Settings / Misc

Change Task Priority Dynamically Printer at Pre file Data Path Storage Watch Text Editor Text Viewer ARexx Execute Run Include Data Path to Resume Even printout Explain Out activities immediately (unimplemented in r33,r34,r35) Default Explanation Warn about disk write events Reopen Device after 'anotherprogram'.
Send keystorkes to Device Make Enters


SETTINGS / SERVICE
OK OK OK OK OK OK OK OK OK OK OK Settings / Service

Service Span Weekday(s) Pre Service scr. Post Service scr. Inactive script Disk-icon Pre Serv. scr. stat. Post Serv. scr. stat. Reset Unknown to BBS Only VIP as non BBS


SETTINGS / LOGS
OK OK OK OK OK OK OK OK OK OK OK Settings / Logs

Main Log ON/OFF Small Log ON/OFF Lifespan Log ON/OFF Save Frequency Received Log ON/OFF Outgoing Log ON/OFF Device Log ON/OFF Start /Quit ON/OFF ARexx Log ON/OFF Request Log ON/OFF In Log ON/OFF Out Log ON/OFF



SETTINGS / SCRIPTS
OK OK OK OK OK OK OK OK OK OK OK Settings / Scripts

On Startup Unknown Known BBS No BBS time FAX Secret n. No number VIP On Exit Execute Script after.. Execute Extra after..

NOTE: For easy editing of the scripts (once specified), double click the 'Disk'-gadget.

To execute script as an ARexx one, then append '.rexx' to the end of script name (in lower case).



SETTINGS / GUI
OK OK OK OK OK OK OK OK OK OK OK Settings / GUI

Time separator Date separator Date format Open Incoming Call window Pop-up Sound Start with Squeezed window Notify new calls if Squeezed Draw Icons Smart window refresh Progressive Window area clears Use original ThinPaz-font Help messages Display all Error messages Password Lock (Squeezed) Specify



SETTINGS / PLUGINS
OK OK OK OK OK OK OK OK OK OK OK Settings / PLUGINS

#0,#1,#2 External Plugin at


SETTINGS / D
OK OK OK OK OK OK OK OK OK OK OK Settings / PLUGINS

Plugin Parameters




DATA BASE
Data Base

Add
Modify

Delete

Print

Search


ARexx


The ARexx Port name information is available from About window.

To execute these commands from Shell type for example:


Possible Return Codes in CIM V2 R31->:
RC Explanation
0 Command was successfully executed, also true.
5 Fail or Not true
6 Required parameter(s) missing
9 Command execution only available for registered users
20 Command was not recognized


Current ARexx Commands in CIM V2 and V3: (Some commands are former FRC-commands, FRC-ones are not implemented any more)

DEVICE RELATED
COMMAND PURPOSE RC RESULT Additional info
DEVICE_OPEN Open device configured in Settings/Device 0 if Ok 5 if Fail none Requires CIM V2.000 or better
DEVICE_RELEASE Releases the Device 0 none Requires CIM V2.000 or better
DEVICE_RESET Sends Reset string to Device if Online If Device is currenty other than Online then returns 5, only available with versions over V2.2610 none Requires CIM V2.000 or better
CURRENT_DEVICE Use to obtain the current configured Device and Unit information. Note: To obtain the up to date information you should use command DEVICE_OPEN before 0 Current Device and Unit information Requires CIM V2.020 or better
IS_RESET_OK Is reset OK respond received? If reset respond received then 0 else 5 none Requires CIM V2.022 or better
IS_ONLINE Is CIM Online? If CIM Internal Status is online then 0 else 5 none Requires CIM V2.024 or better
CURRENT_STATUS CIM's current Internal Status 0 online, offline, anotherprogram, voice, vbs Requires CIM V2.024 or better
DEVICE_RESET_YES Turns On Device reset 0 none Requires CIM V2.367 or better
DEVICE_RESET_NO Turns Off Device reset 0 none Requires CIM V2.367 or better
DEVICE_SEEKOK_YES Turns On Device OK respond seek 0 none Requires CIM V2.367 or better
DEVICE_SEEKOK_NO Turns Off Device OK respond seek 0 none Requires CIM V2.367 or better
DEVICE_PH Pickup & hangup the Device 0 none Requires CIM V2.800 or better
DEVICE_WRITE "STRING TO SEND" Will write the given string to Device if in Online mode 0 or 5 none Requires CIM V2.828 or better
DEVICE_ASCII_WRITE the_ascii_value Will write the ascii char to Device if in Online mode 0 or 5 none Requires CIM V2.987 or better
DEVICE_ENTER Sends ASCII 13 to the Device if in Online mode. Should be used after DEVICE_WRITE-command. 0 or 5 none Requires CIM V2.828 or better
DEVICE_OCP Returns 5 if internal status is not online and if Incoming call process is currently going on. 0 or 5 none Requires CIM V2.940 or better

SERVICE (BBS) RELATED:
COMMAND PURPOSE RC RESULT Additional info
SERVICE_PRE Executes Pre-script 0 or 9 none Requires CIM V2.000 or better, RC 9 requires V2.617 or better
SERVICE_POST Executes Post-script 0 or 9 none Requires CIM V2.000 or better, RC 9 requires V2.617 or better
SERVICE_RESET Resets Service 0 or 9 none Requires CIM V2.000 or better, RC 9 requires V2.617 or better
DEVICE_ANSWER 0 or 9 none Requires CIM V2.000 or better, RC 9 requires V2.617 or better
DEVICE_HU Hangup the Device 0 none Requires CIM V2.800 or better

INCOMING CALL CONFIG:
COMMAND PURPOSE RC RESULT Additional info
POPUP_NO Turns off Pop-up function 0 none Requires CIM V2.000 or better
POPUP_YES Turns on Pop-up function 0 none Requires CIM V2.000 or better
ICW_NEVER 0 none Requires CIM V2.000 or better
ICW_IFI< 0 none Requires CIM V2.000 or better
ICW_ALWAYS 0 none Requires CIM V2.000 or better
SOUND_NEVER 0 none Requires CIM V2.000 or better
SOUND_ONCE 0 none Requires CIM V2.000 or better
SOUND_ALL 0 none Requires CIM V2.000 or better

MISC:
COMMAND PURPOSE RC RESULT Additional info
SETTINGS_LOAD This command should be used after settings have been altered from a script to restore the original settings. 0 none Requires CIM V2.000 or better
CURRENT_CALLERTYPE Returns the Type of current Caller Data 0 Returns one of these: Unknown, Known, FAX, BBS, Voice, VIP, NoNumbrer, Hangup, Secret, User Requires CIM 2.047 or better
RECEIVED_RINGSTR Returns the latest received RING string 0 Distinctive RING (Call Sign)-support
Requires CIM r32 (V3) or better
QUIT 0 none Requires CIM V2.000 or better
VERSION_COMMANDSET Gives the version number of CIM 0 Version number Requires CIM V2.031 or better
RELEASE_NUMBER Gives the release number of CIM 0 Release number Requires CIM r32 (V3.x) or better
IN_NAME "string to search" Will look for a match from Name-filed RC=0 if the given CASE sensitive string is found from Name-field, else RC=5 Requires CIM V2.242 or better
IN_COMMENT "string to search" Will look for a match from Comment-filed RC=0 if the given CASE sensitive string is found from Name-field, else RC=5 Requires CIM V2.251 or better
DATA_ALTERED This makes CIM to know that a Plugin /script has altered some Caller data. Since r40 this command also reads message # an In-/Out logs data count. 0 none Requires CIM V2.370 or better
USE_PLUGINNMBR 0-2 R36 or better accepts 0-5 Switches to the Plugin specified by the bank number. 0 none Requires CIM R32 (V3.x) or better. Major changes in Release 39 (V3.6x). 0='Show Events', 1='RefG', 2='-', 3='User Plugin #1', 4='User Plugin #2', 5='User Plugin #3'
CURRENT_PLUGINNMBR Returns the current Plugin's number 0 0-2, Release 39 (V3.6x) or better gives 0-5 Requires CIM R32 (3.x) or better. Major changes in Release 39 (V3.6x).
CURRENT_PLUGINNAME Returns the current Name without path 5 if the Plugin is not available, example if incorrect path. PluginName Requires CIM R32 (V3.x) or better
START_SCRAMBLE Executes Scramble-plugin if available. Requires CIM R32 (V3.x) or better
INACTIVE_RESET Resets Inactive-counter. 0 Requires CIM R32 (V3.x) or better
PRINTFILE "drive:path/theFile" Prints the file to the 'Printer at'-destination, specified in Settings/Misc. Note: The complete path to the file must be included. Requires CIM R32 (V3.x) or better
SWATCH_DEVICE "NewStorageDriveToWatch:" Use to change the Storage Watch Device. Give only a Device name, example HD0: or Assign.
Requires CIM R32 (V3.x) or better
SWATCH_SETALIMIT "StorageDrive:" Use to change the Storage Watch Alarm Limit in KiloBytes. Executes the Script on low space situation only if Storage Watch is enabled from Settings/Misc.
Requires CIM R32 (V3.x) or better
SWATCH_CURRENTDEVICE Returns the Storage Device watched Requires CIM R32 (V3.x) or better
SWATCH_SPACELEFT Returns space left information from the Storage Device watched Works even if Storage Watch is disabled from Settings/Misc
Requires CIM R32 (V3.x) or better
SET_TASKPRIORITY "priority" Alters CIM's Normal Mode task priority, default: 1. Value between -1 ... 5 recommended. Requires CIM R32 (V3.x) or better
SET_TYPE "ScriptType" Changes Script Type of the current record. Known, FAX, BBS, Voice, VIP, NoNumbrer, Hangup, Secret, User etc. The change is not saved with this command. This command should only be used if an Incoming call is going on. Use DEVICE_OCP command to examine the status.
Requires CIM R32 (V3.x) or better
SET_SCRIPT "device:drawer/script" Changes Script of the current record. Should only to be used with User-Script Type The change is not saved with this command. This command should only be used if an Incoming call is going on. Use DEVICE_OCP command to examine the status.
Requires CIM R32 (V3.x) or better
SCRIPT_EXERESET Reset Script execution flag Requires CIM r32 or better
SET_DEVICEDATAWAIT ticks This alters the value of ticks to wait to some new data to appear to Device buffer before whole buffered data will be processed.

Default value is 32 and should work reliable with 9600 baud. (50 ticks = 1 sec.)
Requires CIM r32 or better
CBDAY This is used to check if the Birthday is today.
Returns 5 if not. none Requires CIM r36 or better.

This function requires that BDay and BMonth are in 2 digit format.
CBDAYINFUTURE days This is used to check how near the Birthday is in the future.
Returns 5 if not found in the given time period. none Requires CIM r36 or better.

This function requires that BDay and BMonth are in 2 digit format.
GIVE_UFDATESTR
Unformatted Date string. Requires CIM r39 or better.
GIVE_UFTIMESTR
Unformatted Time string. Requires CIM r39 or better.

WINDOW OPEN /CLOSE /REDRAW:
COMMAND PURPOSE RC RESULT Additional info
WINDOW_OPEN_ABOUT Open About window at current 'page' 0 none Requires CIM V2.020 or better
WINDOW_OPEN_ABOUT_SYSINFO Open About window at Sysinfo page 0 none Requires CIM V2.021 or better
WINDOW_CLOSE_ABOUT Close About window 0 none Requires CIM V2.022 or better
GUI_LOCK Locks the GUI so user can't access the gadgets. 0 none Requires CIM V2.027 or better
GUI_UNLOCK Unlocks the GUI 0 none Requires CIM V2.027 or better
GUI_UPDATE Redraws Main and Data Base Browse-windows 0 none Requires CIM V2.237 or better
MESSAGE_MAKE "My Message" Creates a message window 0 none Requires CIM V2.388 or better
BDAYMESSAGE_DTG This command is used in conjuction with CBDAYINFUTURE-ARexx command to display the Birthday check result in CIM's Message window. 0 none Requires CIM r36 or better.

This function requires that BDay and BMonth are in 2 digit format.
WINDOW_CLEANUP Will close all the windows (except Input, Incoming Call) and go to Squeezed mode. It will also reset to Latest Caller data if Incoming call is not going on. 0 none Requires CIM V2.972 or better



INTERNAL STATUS


STATUS EXPLANATION
modemoff The Device (modem) is switched off
online CIM sits on the device and is ready for incoming calls
offline CIM does not sit on the device and cannot respond to calls
anotherprogram An another program is using the same Device in shared mode. If Out Log is enabled CIM will record the time that is spent by the other program.
voice Answered /Called a voice call. If Out Log is enabled CIM will record the time that is spent.
vbs Video Backup System is connected to the Device port. CIM releases the Device and disables it's error handling so that VBS may work correctly.




Back





Updated: May 31st 2000.
Copyright by Jan-Erik Tervo. All rights reserved.